get /mint/organizations/{org_name}/supported-currencies

Gets supported currencies. See also Retrieving supported currencies using the API.

HTTP request

https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies

Path Parameters

org_name (required)

string

Organization name.

Query Parameters

all

boolean
Default value
false

Flag that specifies whether to return all records. If set to false, the number of records returned per page is defined by the size query parameter.

size

integer
Default value
20

Number of records returned per page. If the all query parameter is set to true, this parameter is ignored.

page

integer
Default value
1

Number of the page that you want to return (if content is paginated). If the all query parameter is set to true, this parameter is ignored.

Response Types

200: 

OK

Body

application/json
SupportedCurrencies
SupportedCurrency

array

Details of the supported currency.

SupportedCurrency
creditLimit

number

The credit limit for the supported currency. The credit limit can be overridden for a developer in the developer's postpaid balance.

Note: This property applies to postpaid developers only.

description (required)

string

Description of the supported currency.

displayName (required)

string

Name displayed in the UI.

id

string

ID of the supported currency.

minimumTopupAmount

number

Minimum amount that developers can add to their prepaid account balance in the specified currency.

Note: This property applies to prepaid developers only.

name (required)

string

ISO 4217 code for the currency, such as usd for United States dollar.

organization (required)

object

id

string

ID of the organization.

status (required)

string

Status of the currency. Valid values include:

  • ACTIVE: The currency is available for use.
  • INACTIVE: The currency is not available for use.
virtualCurrency (required)

string

Flag that specifies whether or not the currency is virtual currency.

totalRecords

integer

Total number of records.

Authentication Requirements

Available Authentication Options
  • Basic
  • OAuth

Try this API

Request parameters
org_name
all
size
page
Credentials
Multi-factor authentication is not supported.